Django를 이용하여 REST API 서버를 제작하기 위한 프레임워크 DRF(Django REST Framework)에 대해 공부합니다. Django를 이용해서 SSR(Server Side Rendering) 웹 페이지를 만들 수 있지만 우리는 REST API 서버를 만드는 것이 목적이기 때문에 템플릿에 관한 부분은 생략하도록 하겠습니다.

먼저 필요한 패키지들을 설치해줍시다.

1

패키지 설치를 완료하였다면 django-admin을 이용하여 간단한 프로젝트를 하나 생성해보죠.

1

아래와 같이 프로젝트 파일들이 생성된 것을 볼 수 있습니다.

1

settings.py 파일에서 여러 셋팅을 관리합니다. DRF를 사용하기 위해 해당 파일에 아래와 같이 내용을 추가해줍시다.

1

이제 Django가 프로젝트 시작 시 DRF를 로드하도록 지시합니다. 이제 서버를 실행시켜 봅시다.

1

서버를 열고 해당 URL로 접속하면 위와 같은 화면이 뜨는 것을 볼 수 있습니다. 포트 번호를 변경하거나 외부 접속을 허용하기 위해 아래와 같이 설정할 수도 있죠.

1

아래와 같이 Database에 적용되지 않은 변경사항(migrations)들에 대한 경고들은 나중에 다루도록 하겠습니다.

이제 앞으로 데이터를 R/W 하기 위한 DB를 연결해주는 부분을 보도록 하겠습니다. DB는 간단하게 MySQL을 Docker를 이용하여 구축하도록 할게요.

1

MySQL을 Django에서 사용하기 위해서 mysqlclient 패키지를 설치해줍시다.

1

이전에 프로젝트를 생성하며 함께 생성된 파일중 settings.py를 보면 DB와 관련된 설정하는 부분이 있습니다. 이 부분을 변경하여 구축한 MySQL DB와 연결하도록 해볼게요.

1

1

이제 DB에 등록할 객체를 생성하는 방법을 해보도록 할게요. 먼저 계정에 대한 정보를 담는 Table을 생성하도록 하겠습니다.

1

위 명령어를 사용하면 아래와 같이 파일들이 생성되는 것을 볼 수 있습니다.

1

여기서 models.py 파일에 모델을 구축하도록 하겠습니다.

1

이제 해당 어플리케이션이 만들어졌다는 것을 알려주어야 합니다. settings.py에 아래와 같이 알려주도록 합시다.

1

또 변화가 발생했다는 것을 DB에 알려주어야 합니다.

1

이제 DB를 보면 새로운 테이블이 생긴것을 확인할 수 있습니다.

서버를 실행하고 /admin 페이지로 가보면 로그인이 필요합니다. superuser 계정을 만들어서 로그인을 진행합시다.

1

해당 페이지에서 추가한 Account 내용이 보이지 않죠. 이를 추가하기 위해서 admin.py 파일을 수정합니다.

1

각 테이블의 Add 버튼을 눌러 매뉴얼하게 데이터를 추가할 수 있습니다.

이제 만들어둔 테이블의 데이터를 CRUD 하는 방법을 보겠습니다.

웹과 데이터를 주고 받기 위해 Serializer라는 객체를 json 형식으로 바꿔주는 과정이 필요합니다. 생성된 account 폴더에 serializer.py 파일을 생성해 아래와 같이 내용을 적어줍시다.

1

위에서는 모든 field에 대해 전달해주기 위해 __all__을 사용하였지만, 추후에는 비밀번호와 같은 민감한 정보에 대해서는 전달해 주지 않도록 변경하는 작업을 진행해야 합니다.

이제 API에 대한 내용을 views.py 에 작성하여 모든 account에 대한 정보를 전달하는 내용을 작성해봅시다.

1

여기서 Account.object.all은 데이터베이스로부터 데이터를 읽고 전달받은 모델의 객체 목록입니다. 이를 Serializer를 통해 JSON 형식으로 변경하는 것이죠. 이러한 방식이 바로 Django의 ORM(Object Relational Mapping)입니다. SQL 명령문이 아닌 비교적 간단한 Python 명령으로 데이터베이스를 다룰 수 있죠.

여러 데이터를 가져오도록 해야 하니까 many를 True로 주었습니다. 기본 값이 False라서 하나의 데이터만 가져오는 경우는 굳이 파라미터를 전달하지 않아도 되겠어요.

마지막으로 urls.py 에 해당 API의 주소를 입력해주고 브라우저를 통해 확인을 하도록 해봅시다.

1

앞서 GET Method를 생성한 것과 비슷한 방법으로 POST를 생성하도록 하겠습니다. views.py 파일을 수정해보죠.

1

Request로 부터 데이터를 받아와 Serializer를 통해 객체로 생성합니다. 이때 데이터의 유효성을 판단하여 상태를 반환하죠. Account List 페이지에 가보면 아래와 같은 입력가능한 컴포넌트가 뜨는 것을 확인할 수 있습니다. 여기에 데이터의 형식에 맞게 입력하여 데이터를 생성해보도록 하죠.

데이터를 업데이트 하는 요청을 제작하기 위해서 먼저 특정한 데이터만 가져오는 코드를 구현하려 합니다.

1

AccountDetail이라는 새로운 클래스를 하나 생성하였습니다. 이제 URL을 통해 API에 접근할 수 있도록 urls.py에 또 추가를 해야겠죠?

1

Account의 ID는 Int 형태로 저장되고 있기 때문에 위와 같은 형태로 값을 받아서 API에 접근하려 합니다. 이를 테스트해보면 다음과 같은 결과가 나오죠. /api/account/1 로 접속을 하도록 하겠습니다.

접속하는 ID 값으로 어떠한 데이터에 접근하려고 하는지 명시해줄 수 있습니다. 이를 조금 더 이용하여 데이터를 업데이트 하는 PUT API를 생성하도록 하죠.

1

POST랑 굉장히 비슷한 형태를 가지고 있습니다. 이제 /api/account/1 에 PUT으로 password를 변경해보겠습니다.

PUT 요청을 할 때, account_number라는 field를 주지 않아서 발생하는 오류입니다. 하지만 우리는 password에 대해서만 변경하고 싶으니 Account의 Serializer를 약간 수정하도록 하겠습니다.

1

그리고 아까와 동일한 요청을 보내면 아래와 같은 결과가 생성되는 것을 볼 수 있습니다.

이제 데이터를 삭제하는 DELETE를 구현해보죠.

1

모델을 찾아 삭제해주기만 하면 완료됩니다. 이제 해당 페이지에 들어가면 DELETE 버튼이 생성됩니다. 이를 누르면 데이터가 삭제되는 것을 확인할 수 있습니다.

위에서 APIView를 이용한 클래스 기반 API를 작성하였습니다. 하지만 아래와 같이 함수 기반으로 API를 작성할 수도 있죠.

1

1

간단한 API는 굳이 클래스 기반으로 만들 필요 없이 함수 기반으로 만들어도 될 것 같습니다.

대략적인 API를 구현하는 방법은 알게 되었으니, 처음부터 다시 프로젝트를 만들어서 사용자와 계좌 모델을 만들고 돈을 송금하는 Usecase를 만들어볼게요.

Django를 설치하고 DB를 설정한 후 migrate 명령을 실행했을 때 DB에 처음 보는 테이블이 생성되는 것을 볼 수 있었습니다. 특히 기본적으로 생성된 테이블에서 auth_user라는 테이블을 볼 수 있죠. 해당 테이블은 아래와 같은 Field들을 가지고 있습니다.

여기에 추가적으로 필요한 정보를 더해 accounts라는 앱을 생성하도록 하겠습니다. Django에서는 기본적으로 제공하는 AbstractBaseUser 객체를 이용하면 쉽게 커스텀한 User를 생성할 수 있습니다.

1

기본 Field와는 다르게 User를 구성하였습니다. 여기서 BaseUserManager는 User를 생성하는 역할을 하는 Django에서 기본적으로 지원하는 클래스입니다. User를 생성할 때 비밀번호만 set_password() 함수를 이용해서 저장하는데, 이는 기본적으로 BaseUserManager클래스의 set_password 함수를 이용해야 암호화를 통해 저장되기 때문입니다.

PermissionsMixin는 권한과 관련된 부분인데 이는 뒤에서 다루도록 하겠습니다.

Django에게 APP을 등록하고 우리가 User 모델을 따로 정의했다는 사실을 알려주기 위해 settings.py에 아래 내용을 추가해야 합니다.

1

이제 makemigrations, migrate 를 실행하고 생성된 테이블을 확인해보죠.

이제 변경한 Field에 민감한 데이터를 제외하고 Serializer를 통해 객체와 데이터를 변경하는 부분을 구현합시다.

1

Serializer에서 모든 Field에 대해 접근할 수 있어야 생성시 각 Field에 대해 데이터를 전달해줄 수 있습니다. 하지만 비밀번호와 같은 정보는 GET을 통해 공개되어서는 안되는 중요한 정보이죠. 그래서 write_only 값을 주어 객체에서 변환시에 해당 값들을 변환하지 않도록 하여 정보를 전달하지 않습니다.

이제 각 객체에 대해 API를 생성하도록 하겠습니다.

1

기존에 구현한 방식은 POST와 PUT이 거의 비슷한 형태를 가지는 것과 같이 중복되는 코드로 인해 가독성이 떨어집니다. generics를 이용하면 조금 더 편리하게 API를 설계할 수 있습니다. 실제로 해당 코드의 구현부분을 가면 아래와 같이 정의되어 있습니다.

1

GET과 POST에 대해 정의를 하고 있죠. 이를 활용하여 가독성이 높은 코드를 간단하게 생성할 수 있겠습니다.

1

1

generics로 생성한 클래스 기반 규칙에 맞춰 URL를 정의하였습니다. 이렇게 앱단위로 URL을 정의한 후 프로젝트의 urls.py 에서 아래와 같이 설정하면 [프로젝트 URL]/[앱 URL] 형식으로 접근할 수 있습니다.

사실 Custom User를 만드는 위 방법 이외에도 여러 가지가 존재합니다.

아래의 두 방법은 프로젝트를 처음 시작할 때 User에 관한 정보를 탄탄하게 설계하고 시작하는 것이 좋습니다.

이제 생성된 User를 이용하여 사용자 인증을 하는 방법을 알아보도록 할게요. DRF는 기본적으로 Session 방식을 채택하고 있습니다. 이를 JWT 방식으로 변경하여 개발해보죠.

먼저 simple-jwt 패키지를 설치합니다.

1

이제 settings.py 에 여러 우리가 simple-jwt 를 사용한다는 것을 알려야 합니다.

1

INSTALLED_APPS 에서 simple-jwt를 사용한다는 것을 명시해주었습니다. REST_FRAMEWORK 에서는 기본 authentication 으로 simple-jwt을 사용하도록 설정해주었죠. 마지막으로 토큰에 대한 설정값을 명시해주었습니다. 설정에 대한 설명은 아래 링크에서 조금 더 자세하게 확인할 수 있어요.

이제 토큰을 획득하고, 토큰을 갱신하는 view를 추가해줍니다.

1

이제 해당 URL로 접속해서 이메일과 패스워드를 이용하여 아래와 같이 토큰을 받을 수 있습니다.

기존의 Refresh Token을 이용하여 새로운 Token을 받아올 수 있죠.

디버거를 이용하여 실행 순서를 살펴보니 Request가 들어오면 _authenticate 함수가 실행됩니다. 여기서 우리가 기본으로 설정한 Authentication 클래스가 호출되는 것이죠.

1

앞서 JWTAuthentication 클래스를 기본으로 설정하였으니 토큰을 이용해 인증을 합니다. 그리고 인증을 통해 어떠한 유저의 요청인지 파악하고 이를 Request에 넣어줍니다.

이제 사용자에 대한 인증을 하였으니 각 권한별로 접근할 수 있는 API에 대해 설정을 하려고 합니다. 로그인을 하지 않은 사용자에 대해서 로그인, 회원가입 기능만을 접근하도록 하고 나머지를 차단해야겠죠. 유저에 대한 정보를 보는 것은 Staff 또는 본인 스스로만 가능해야 합니다. 모든 유저를 볼 수 있는 API는 Staff 이상만이 접근할 수 있어야 하죠.

기본적으로 AllowAny, IsAuthenticated, IsAdminUser 와 같은 기본적으로 제공하는 권한이 있습니다. 하지만 우리는 User 에 관한 정보를 조회할 때 자기 자신만 허용하려고 하죠. 그래서 추가적인 권한을 만들어야 합니다.

1

모든 권한은 BasePermission 클래스를 상속합니다. 해당 클래스는 has_permission과 has_object_permission이 있죠. 먼저 has_permission을 통해 권한을 확인하고 has_object_permission이 구현되어 있다면 이를 또 실행하죠. 따라서 기본적으로 인증된 사용자에 대해서 Staff 혹은 자기 자신인지 확인하도록 구현하였습니다.

1

클래스 기반 View 들은 permission_classes 를 지정해서 권한을 설정할 수 있습니다. 각 View 에 해당하는 URL도 설정해줍니다.

1

이제 이를 테스트해보죠.

로그인을 하면 각 토큰을 반환합니다.

해당 토큰을 헤더에 settings.py 에서 설정한 AUTH_HEADER_TYPES 와 함께 넣어주고 API를 호출하면 결가가 제대로 나오는 것을 볼 수 있습니다.

그러나 다른 유저의 정보를 보려고 할 때 오류가 나는 것을 볼 수 있죠.

다시 Staff 계정으로 로그인한 후, 이 토큰을 이용해 다른 유저의 정보에 접근해보면 모두 볼 수 있는 것을 확인할 수 있습니다.